<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>coinductive/1 &mdash; The Logtalk Handbook v3.93.0-b01 documentation</title>
      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d75fae25" />
      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="../../_static/css/custom.css?v=396eccfe" />

  
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="../../_static/jquery.js?v=5d32c60e"></script>
        <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="../../_static/documentation_options.js?v=c8100655"></script>
        <script src="../../_static/doctools.js?v=9a2dae69"></script>
        <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../../_static/js/theme.js"></script>
    <!-- begin favicon -->
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
    <link rel="manifest" href="/site.webmanifest" />
    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5" />
    <meta name="msapplication-TileColor" content="#355b95" />
    <meta name="theme-color" content="#ffffff" />
    <!-- end favicon -->
    
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="discontiguous/1" href="discontiguous_1.html" />
    <link rel="prev" title="alias/2" href="alias_2.html" />
   
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../../index.html" class="icon icon-home">
            The Logtalk Handbook
              <img src="../../_static/logtalk.gif" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                3.93.0
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    
              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../userman/index.html">User Manual</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Reference Manual</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../grammar.html">Grammar</a></li>
<li class="toctree-l2"><a class="reference internal" href="../control/index.html">Control constructs</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Directives</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="source_file_directives.html">Source file directives</a></li>
<li class="toctree-l3"><a class="reference internal" href="conditional_compilation_directives.html">Conditional compilation directives</a></li>
<li class="toctree-l3"><a class="reference internal" href="entity_directives.html">Entity directives</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="predicate_directives.html">Predicate directives</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="alias_2.html"><code class="docutils literal notranslate"><span class="pre">alias/2</span></code></a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">coinductive/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="discontiguous_1.html"><code class="docutils literal notranslate"><span class="pre">discontiguous/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamic_1.html"><code class="docutils literal notranslate"><span class="pre">dynamic/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="info_2.html"><code class="docutils literal notranslate"><span class="pre">info/2</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="meta_predicate_1.html"><code class="docutils literal notranslate"><span class="pre">meta_predicate/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="meta_non_terminal_1.html"><code class="docutils literal notranslate"><span class="pre">meta_non_terminal/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="mode_2.html"><code class="docutils literal notranslate"><span class="pre">mode/2</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="multifile_1.html"><code class="docutils literal notranslate"><span class="pre">multifile/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="op_3.html"><code class="docutils literal notranslate"><span class="pre">op/3</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="private_1.html"><code class="docutils literal notranslate"><span class="pre">private/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="protected_1.html"><code class="docutils literal notranslate"><span class="pre">protected/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="public_1.html"><code class="docutils literal notranslate"><span class="pre">public/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="synchronized_1.html"><code class="docutils literal notranslate"><span class="pre">synchronized/1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="uses_2.html"><code class="docutils literal notranslate"><span class="pre">uses/2</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="use_module_2.html"><code class="docutils literal notranslate"><span class="pre">use_module/2</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../predicates/index.html">Built-in predicates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../methods/index.html">Built-in methods</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial/index.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../devtools/index.html">Developer Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../libraries/index.html">Libraries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ports/index.html">Ports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributions/index.html">Contributions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../bibliography.html">Bibliography</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../genindex.html">Index</a></li>
</ul>

    <p class="caption"><span class="caption-text">External Contents</span></p>
    <ul>
    <li class="toctree-l1"><a class="reference internal" href="../../../apis/index.html">APIs</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://logtalk.org">Logtalk website</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://github.com/LogtalkDotOrg/logtalk3">GitHub repo</a></li>
    </ul>
  
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../index.html">The Logtalk Handbook</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../index.html">Reference Manual</a></li>
          <li class="breadcrumb-item"><a href="index.html">Directives</a></li>
          <li class="breadcrumb-item"><a href="predicate_directives.html">Predicate directives</a></li>
      <li class="breadcrumb-item active"><code class="docutils literal notranslate"><span class="pre">coinductive/1</span></code></li>
      <li class="wy-breadcrumbs-aside">
              <a href="https://github.com/LogtalkDotOrg/logtalk3/blob/master/docs/handbook/sources/refman/directives/coinductive_1.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <p class="align-right"><strong>directive</strong></p>
<section id="coinductive-1">
<span id="directives-coinductive-1"></span><span id="index-0"></span><h1><code class="docutils literal notranslate"><span class="pre">coinductive/1</span></code><a class="headerlink" href="#coinductive-1" title="Link to this heading"></a></h1>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Link to this heading"></a></h2>
<div class="highlight-logtalk notranslate"><div class="highlight"><pre><span></span>coinductive(<span class="nv">Name</span><span class="o">/</span><span class="nv">Arity</span>)
coinductive((<span class="nv">Name</span><span class="o">/</span><span class="nv">Arity</span>, ...))
coinductive([<span class="nv">Name</span><span class="o">/</span><span class="nv">Arity</span>, ...])

coinductive(<span class="nv">Name</span><span class="o">//</span><span class="nv">Arity</span>)
coinductive((<span class="nv">Name</span><span class="o">//</span><span class="nv">Arity</span>, ...))
coinductive([<span class="nv">Name</span><span class="o">//</span><span class="nv">Arity</span>, ...])

coinductive(<span class="nv">Template</span>)
coinductive((<span class="nv">Template1</span>, ...))
coinductive([<span class="nv">Template1</span>, ...])
</pre></div>
</div>
<p>This is an <strong>experimental</strong> directive, used for declaring
<a class="reference internal" href="../../glossary.html#term-coinductive-predicate"><span class="xref std std-term">coinductive</span></a> predicates. Requires a
<a class="reference internal" href="../../glossary.html#term-backend-Prolog-compiler"><span class="xref std std-term">backend Prolog compiler</span></a> with minimal support for cyclic terms.
The current implementation of coinduction allows the generation of only
the <em>basic cycles</em> but all valid solutions should be recognized. Use a
predicate indicator or a non-terminal indicator as argument when all the
coinductive predicate arguments are relevant for coinductive success.
Use a template when only some coinductive predicate arguments (represented
by a “<code class="docutils literal notranslate"><span class="pre">+</span></code>”) should be considered when testing for coinductive success
(represent the arguments that should be disregarded by a “<code class="docutils literal notranslate"><span class="pre">-</span></code>“). It’s
possible to define local <a class="reference internal" href="../methods/coinductive_success_hook_1_2.html#methods-coinductive-success-hook-1-2"><span class="std std-ref">coinductive_success_hook/1-2</span></a>
predicates that are automatically called with the coinductive predicate
term resulting from a successful unification with an ancestor goal as
first argument. The second argument, when present, is the coinductive
hypothesis (i.e., the ancestor goal) used. These hook predicates can
provide an alternative to the use of tabling when defining some
coinductive predicates. There is no overhead when these hook predicates
are not defined.</p>
<p>This directive must precede any calls to the declared coinductive
predicates.</p>
</section>
<section id="template-and-modes">
<h2>Template and modes<a class="headerlink" href="#template-and-modes" title="Link to this heading"></a></h2>
<div class="highlight-logtalk notranslate"><div class="highlight"><pre><span></span>coinductive(<span class="o">+</span>predicate_indicator_term)
coinductive(<span class="o">+</span>non_terminal_indicator_term)
coinductive(<span class="o">+</span>coinductive_predicate_template_term)
</pre></div>
</div>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-logtalk notranslate"><div class="highlight"><pre><span></span><span class="p">:- </span><span class="k">coinductive</span>(comember<span class="o">/</span><span class="m">2</span>).
<span class="p">:- </span><span class="k">coinductive</span>(ones_and_zeros<span class="o">//</span><span class="m">0</span>).
<span class="p">:- </span><span class="k">coinductive</span>(controller(<span class="o">+</span>,<span class="o">+</span>,<span class="o">+</span>,<span class="o">-</span>,<span class="o">-</span>)).
</pre></div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="../methods/coinductive_success_hook_1_2.html#methods-coinductive-success-hook-1-2"><span class="std std-ref">coinductive_success_hook/1-2</span></a>,
<a class="reference internal" href="../methods/predicate_property_2.html#methods-predicate-property-2"><span class="std std-ref">predicate_property/2</span></a></p>
</div>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="alias_2.html" class="btn btn-neutral float-left" title="alias/2" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="discontiguous_1.html" class="btn btn-neutral float-right" title="discontiguous/1" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 1998-2025, Paulo Moura.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>